<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
<html>
<head>
<title>DRV_USART_ErrorGet Function</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="Doc-O-Matic" />
    <meta http-equiv="Content-Style-Type" content="text/css" />
    <link rel="STYLESHEET" href="default.css" type="text/css" />

<script type="text/javascript" src="scripts.js"></script>
</head>
<body class="Element700" onload="onBodyLoadEx('frames.html', 'topic', '00573.html');" onmousedown="onBodyMouseDown();">

<!-- Begin Popups -->

<!-- End Popups -->

<!-- Begin Page Header -->
<div class="Element710" id="areafixed">
<div class="Element94">
<a href="00007.html" target="topic">Driver Libraries Help</a> &gt; <a href="00165.html" target="topic">USART Driver Library Help</a> &gt; <a href="00166.html" target="topic">Library Interface</a> &gt; c) Data Transfer Functions &gt; <a href="00573.html" target="topic">DRV_USART_ErrorGet Function</a></div>
<div class="Element92">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element1">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element2">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element90">
<a href="00586.html" target="topic">Previous</a> | <a href="00166.html" target="topic">Up</a> | <a href="00577.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element96">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: DRV_USART_ErrorGet@DRV_USART_BUFFER_HANDLE Topic Title: DRV_USART_ErrorGet Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table><div class="Element5">
DRV_USART_ErrorGet Function</div>
</div>
</div>

<!-- End Page Header -->

<!-- Begin Client Area -->
<div class="Element720" id="areascroll">
<div class="Element721">

<!-- Begin Page Content -->
<a name="PageContent"></a><div class="Element58">
<a name="4465736372697074696F6E"></a><div class="Element11">
<div class="Element10">
<p class="Element10">
This function returns the errors associated with the given bufferHandle. The call to this function also clears all the associated error flags. This function can be used for non-DMA buffer transfers only. It cannot be used when the USART driver is configured to use DMA.</p></div>
</div>
<a name="43"></a><div class="Element99">
C</div>
<div class="Element101"><div class="Element100"><pre class="Element100"><a href="00572.html" target="topic">DRV_USART_ERROR</a> <strong><span style="color: #000000">DRV_USART_ErrorGet</span></strong>(
    <strong><span style="color: #000080">const</span></strong> <a href="00566.html" target="topic">DRV_USART_BUFFER_HANDLE</a> <strong><span style="color: #000000">bufferHandle</span></strong>
);</pre></div></div>
<a name="507265636F6E646974696F6E73"></a><div class="Element14">
Preconditions</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
<a href="00576.html" target="topic">DRV_USART_Open</a> must have been called to obtain a valid opened device handle.</p></div>
</div>
<a name="506172616D6574657273"></a><div class="Element14">
Parameters</div>
<div class="Element11">
<div class="Element10">
<div class="Element312">
<div class="TableDiv">
<table cellspacing="0" class="Table3">
<tr>
<td class="Element300" valign="top" width="35%">
<div class="Element301">
Parameters&nbsp;</div></td><td class="Element304" valign="top" width="65%">
<div class="Element305">
Description&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
bufferHandle&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
A valid handle to the transfer request&nbsp;</div></td></tr></table></div></div>
</div>
</div>
<a name="52657475726E73"></a><div class="Element14">
Returns</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
Errors occurred as listed by <a href="00572.html" target="topic">DRV_USART_ERROR</a>. This function reports multiple USART errors if occurred.</p></div>
</div>
<a name="52656D61726B73"></a><div class="Element14">
Remarks</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
USART errors are normally associated with the receiver. Once the DRV_USART_ErrorGet API is called by the application, the errors are cleared (set to DRV_USART_ERROR_NONE) by the driver. The errors remain valid only until the buffer object associated with the bufferHandle is not assigned to another transfer request; in which case the API returns the error status as DRV_USART_ERROR_NONE. Hence, application may want to call this routine from the callback routine itself, in case where an error is reported by the driver in the callback. This function is expected to work in non-DMA mode only.</p></div>
</div>
<a name="4578616D706C65"></a><div class="Element14">
Example</div>
<div class="Element11">
<div class="Element10">
<div class="Element13"><div class="Element12"><pre class="Element12"><i><span style="color: #008000">// 'bufferHandle', returned from the DRV_USART_ReadBufferAdd</span></i>

<strong><span style="color: #000080">if</span></strong> (DRV_USART_ErrorGet(bufferHandle) &amp; DRV_USART_ERROR_OVERRUN)
{
    <i><span style="color: #008000">//Errors are cleared by the driver, take respective action</span></i>
    <i><span style="color: #008000">//for the overrun error case.</span></i>
}</pre></div></div>
</div>
</div>
</div>
<!-- End Page Content -->

<!-- Begin Page Footer -->
<div class="Element95">
<a href="00007.html" target="topic">Driver Libraries Help</a> &gt; <a href="00165.html" target="topic">USART Driver Library Help</a> &gt; <a href="00166.html" target="topic">Library Interface</a> &gt; c) Data Transfer Functions &gt; <a href="00573.html" target="topic">DRV_USART_ErrorGet Function</a></div>
<div class="Element93">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element3">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element4">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element91">
<a href="00586.html" target="topic">Previous</a> | <a href="00166.html" target="topic">Up</a> | <a href="00577.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element97">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: DRV_USART_ErrorGet@DRV_USART_BUFFER_HANDLE Topic Title: DRV_USART_ErrorGet Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table></div>

<!-- End Page Footer -->
</div>
</div>

<!-- End Client Area -->
</body></html>